SlaveStatus Class

Represents the states of an EtherCAT slave.

Inheritance Hierarchy

System.Object
IntervalZero.KINGSTAR.Base.Api.SlaveStatus

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

public class SlaveStatus

Public Class SlaveStatus

The SlaveStatus class exposes the following members.

Constructors

	Name	Description
	SlaveStatus	Initializes a new instance of the SlaveStatus class.

Fields

	Name	Description
	AliasAddress	AliasAddress (or station alias) is used to identify multiple identical devices with the same Vendor ID and Product code. It is a software defined value, stored in the device's EEPROM, and can be written using tools or by the EtherCAT master (WriteSlaveAlias). You can set up AliasAddress for devices in specific roles, such as X, Y, and Z axes. When the AliasAddress is changed, the device must be power cycled for the change to take effect. IMPORTANT: The alias address is intended to be a software defined value, but some devices map it to a hardware DIP switch, which corresponds to the ExplicitId. In such cases, the value should never be changed in software, as it may trigger a device error. Please check your device's user manual for the station alias information before using it. NOTE: If a device supports both AliasAddress and ExplicitId, you can use the ExplicitId without configuring the AliasAddress.
	CycleTime	The cycle time for a slave.
	ExplicitId	A preconfigured address used to differentiate same-model devices (drives or I/O modules) on the same network. It must be set before adding the device to the network, either via a rotary DIP switch on the device, or the configuration tool bundled with the device. NOTE: Some devices store the ExplicitId in the EEPROM. Please refer to the device’s ESI file for details on retrieving the ExplicitId.
	InputLength	The length of the input data read from a device.
	Name	The name of a device.
	OutputLength	The length of the output data sent to a device.
	PhysAddress	The physical address of a device, used by the EtherCAT master to access the device. It is configured by the master during startup. Values are 1001 + slave index.
	ProductCode	The product code of a device.
	RequestedState	Reads the EtherCAT state from the latest RequestState function call.
	RevisionNumber	The revision number of a device.
	SerialNumber	The serial number of a device.
	SlaveId	The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.
	SlotId	For IO-Link devices, a slot is an IO-Link port of an IO-Link master that can be connected to an EtherCAT network. SlotId is the ID of a slot where a module (IO-Link slave) is connected. For CAN devices, it is the CAN ID. For non-modular devices, the values are -1.
	State	The EtherCAT state of a device.
	VariableIndexOffset	If you're using multiple-axis servo drives and you want to read the data from one of the axes, you can use this parameter to retrieve the offset value of the SDO object addresses of that axis.
	VendorId	The vendor ID of a device, given by the EtherCAT Technology Group to the manufacturer of the EtherCAT device.